Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add website information to the script data in Elementor #21463

Conversation

igorschoester
Copy link
Member

@igorschoester igorschoester commented Jul 4, 2024

Context

Summary

This PR can be summarized in the following changelog entry:

  • Fixes an unreleased bug where the website information in the wpseoScriptData was no longer present in the Elementor editor.

Relevant technical choices:

This PR is adjusting Elementor for:

The removed variables from the wpseoScriptData.metabox part:

And the removed variables from the wpseoScriptData itself:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Edit a post in the Elementor editor
  • Open the Yoast SEO sidebar
  • Verify you no longer get the error from the issue
  • Open the browser console
  • Run wpseoScriptData.metabox and verify that the following entries are there:
    • base_url and is your site domain
    • contentLocale and is your site locale (en_US?)
    • isPremium is false when you don't have Premium active
    • isRtl is false when you are not using a right to left locale
    • post_edit_url is most likely your site domain plus /wp-admin/post.php?post={id}&action=edit
    • search_url is most likely your site domain plus /wp-admin/edit.php?seo_kw_filter={keyword}
    • siteIconUrl is empty or the site icon URL you entered
    • site_name is your site name
    • userLocale is your user locale (en_US?)
  • Run wpseoScriptData and verify that the following entries are there:
    • dismissedAlerts is (most likely) an empty array
    • currentPromotions is (most likely) an empty array
    • webinarIntroBlockEditorUrl (though not needed due as webinarIntroElementorUrl is used) is https://yoa.st/webinar-intro-block-editor followed by the link params
    • blackFridayBlockEditorUrl is an empty string
    • linkParams is an array with the link params including for example platform: "wordpress"
    • pluginUrl is the url of Yoast SEO plugin, most likely your site domain plus /wp-content/plugins/wordpress-seo
    • wistiaEmbedPermission is either an empty string or 1 (as string)

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes https://github.com/Yoast/plugins-automated-testing/issues/1690

@igorschoester igorschoester added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Jul 4, 2024
@igorschoester igorschoester added this to the 23.1 milestone Jul 4, 2024
@coveralls
Copy link

coveralls commented Jul 4, 2024

Pull Request Test Coverage Report for Build ff9d7066a36125afbfe94a9ba3fb07c1727dfc43

Details

  • 0 of 13 (0.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.005%) to 53.97%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/integrations/third-party/elementor.php 0 13 0.0%
Totals Coverage Status
Change from base Build 27573c1f5576d468d08d1860296cf764bce0e711: -0.005%
Covered Lines: 29266
Relevant Lines: 54536

💛 - Coveralls

@igorschoester igorschoester force-pushed the 1690-231-fatal-error-shows-in-yoast-sidebar-in-upcoming-elementor-release branch from 5378051 to d7f91f6 Compare July 4, 2024 12:14
@coveralls
Copy link

coveralls commented Jul 4, 2024

Pull Request Test Coverage Report for Build 51761e0da77568389bb65dfd20c006791d6f537f

Details

  • 0 of 13 (0.0%) changed or added relevant lines in 1 file are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage increased (+0.001%) to 53.976%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/integrations/third-party/elementor.php 0 13 0.0%
Files with Coverage Reduction New Missed Lines %
src/integrations/third-party/elementor.php 1 0.0%
Totals Coverage Status
Change from base Build 27573c1f5576d468d08d1860296cf764bce0e711: 0.001%
Covered Lines: 29266
Relevant Lines: 54528

💛 - Coveralls

Copy link
Member

@enricobattocchi enricobattocchi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CR & ACC ok

@enricobattocchi enricobattocchi merged commit ff72704 into release/23.1 Jul 4, 2024
22 checks passed
@enricobattocchi enricobattocchi deleted the 1690-231-fatal-error-shows-in-yoast-sidebar-in-upcoming-elementor-release branch July 4, 2024 12:28
@coveralls
Copy link

coveralls commented Jul 4, 2024

Pull Request Test Coverage Report for Build b2fc7d465a768ac4647d081829d3a50572bd7e29

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 16 (0.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.001%) to 53.976%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/integrations/third-party/elementor.php 0 16 0.0%
Totals Coverage Status
Change from base Build 27573c1f5576d468d08d1860296cf764bce0e711: 0.001%
Covered Lines: 29266
Relevant Lines: 54528

💛 - Coveralls

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants